IMotion.SetAxisPositionOffset method

Shifts the coordinate system of an axis by manipulating both the setpoint position as well as the actual position of an axis with the same value without causing any movement (recalibration with same following error). This can be used for instance for a reference situation.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsCommandStatus SetAxisPositionOffset(
       int Index,
       double Position,
       bool Relative,
       McExecutionMode ExecutionMode
)

Function SetAxisPositionOffset(
       Index As Integer,
       Position As Double,
       Relative As Boolean,
       ExecutionMode As McExecutionMode
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Position [in]

Type: double

A position unit (it's the distance unit if Relative is true).

Relative [in]

Type: bool

true if it's relative distance; false if it's absolute position. By default, it is false.

ExecutionMode [in]

Type: McExecutionMode

Defines the chronological sequence of a method.

Return value

Type: KsError

A return code of a method.

Remarks

This method can only be used in the Standstill or Disabled state.
Relative means that Position (distance unit) is added to the actual position of the axis at the time of execution. The resulting target position will be the actual position + distance. For example, the actual position is 50. Distance is 100. The target position will be 150. "Absolute" means that the actual position of the axis is the value specified in the Position parameter.
When modulo axis is enabled, the input value is converted to the modulo position for an absolute mode. However, for a relative mode, the input value is used as a distance rather than a modulo position.

Examples

N/A